---
id: specificationdocumentsettings
title: 7. 规范化文档配置
sidebar_label: 7. 规范化文档配置
---

## 7.1 关于配置

规范化文档配置指的是 `Furion` 框架Swagger文档配置选项。

## 7.2 配置信息

- `SpecificationDocumentSettings`：配置根节点
    - `DocumentTitle`：文档标题，`string`，默认 `Specification Api Document`
    - `DefaultGroupName`：默认分组名，`string`，默认 `Default`
    - `EnableAuthorized`：是否启用权限控制，`bool`，默认 `true`
    - `FormatAsV2`：采用 `Swagger 2.0` 版本，`bool`，默认 `false`
    - `RoutePrefix`：规范化文档地址，`string`，默认 `api`，**如果希望在首页，改为空字符串即可**。
    - `DocExpansionState`：文档显示方式，`DocExpansion`，默认 `List`，取值：
        - `List`：列表式（展开子类），**默认值**
        - `Full`：完全展开
        - `None`：列表式（不展开子类）
    - `XmlComments`：程序集注释描述文件名（可带 `.xml`，`string`，默认 `Furion.Application, Furion.Web.Entry, Furion.Web.Core`
    - `GroupOpenApiInfos`：分组信息配置，`SpecificationOpenApiInfo[]`，默认 `{ 'Group': 'Default'}`
    - `SecurityDefinitions`：安全策略定义配置，`SpecificationOpenApiSecurityScheme[]`，默认 `[]`
    - `Servers`：配置 Server 下拉列表，`OpenApiServer[]` 类型，默认 `[]`，如：`{Servers:[ { Url:"地址", Description:"描述"} ]}`
    - `HideServers`：是否隐藏 Server 下拉列表，`bool` 类型，默认 `false`

## 7.3 配置示例

```json
{
  "SpecificationDocumentSettings": {
    "GroupOpenApiInfos": [
      {
        "Group": "Group1",
        "Title": "分组标题",
        "Description": "这里是分组描述",
        "Version": "版本号",
        "TermsOfService": "https://furion.pro",
        "Contact": {
          "Name": "百小僧",
          "Url": "https://gitee.com/monksoul",
          "Email": "monksoul@outlook.com"
        },
        "License": {
          "Name": "Apache-2.0",
          "Url": "https://gitee.com/monksoul/Furion/blob/alpha/LICENSE"
        }
      }
    ]
  }
}
```
